ccw_Error.h

Go to the documentation of this file.

// File Revision
// Rev 1.00
//
// Rev. notes:
// - rel 1.00: first release
// NOTE: Please DO NOT EDIT THIS FILE


#ifndef _COMMON_CCW_ERROR_H__
#define _COMMON_CCW_ERROR_H__

#include "WinTypes.h"

typedef enum : DWORD
{
    CcwResult_OK = 0,                   

    CcwResult_OpenDeviceError = 1,

    CcwResult_UnsupportedFunction = 2,

    CcwResult_InvalidParameter = 3,

    CcwResult_SmallBuffer = 4,

    CcwResult_NullPointer = 5,

    CcwResult_NotInitialized = 6,

    CcwResult_InvalidDeviceID = 7,

    CcwResult_ReadError = 8,

    CcwResult_WriteError = 9,

    CcwResult_UnsupportedDevice = 10,

    CcwResult_CommunicationError = 11,

    CcwResult_BarcodeUnsupportedError = 12,

    CcwResult_BarcodeWidthError = 13,

    CcwResult_DeviceAlreadyOpenError = 14,

    CcwResult_PrinterNotExistError = 15,

    CcwResult_UnknowPrinterError = 16,

    CcwResult_OpenFileError = 17,

    CcwResult_CommunicationBusy = 18,
    
    CcwResult_GraphicsLibraryNotFound = 19,
    
    CcwResult_BarcodeDataLongError = 20,

    CcwResult_BarcodeInvalidDataError = 21,

    CcwResult_UnknowError = 0xFFFFFFFF,
        
} CcwResult;




// Hide in documentation

typedef struct
{
    CcwResult       ccwError;
    const char* strDescription;
} CcwErrorType;

//Errors List Size
#define ERROR_CCW_LISTSIZE      (sizeof(ERROR_CCW_LIST)/sizeof(CcwErrorType))

//Errors List description                               
const CcwErrorType ERROR_CCW_LIST[] = {
    // Error                            // Error Descrition
    { CcwResult_OK,                     "Ok" },
    { CcwResult_OpenDeviceError,        "Open port or device Error" },
    { CcwResult_UnsupportedFunction,    "Function not supported by this device" },
    { CcwResult_InvalidParameter,       "Parameter value not valid" },
    { CcwResult_SmallBuffer,            "Buffer small" },
    { CcwResult_NullPointer,            "A parameter is NUL" },
    { CcwResult_NotInitialized,         "Library not initialized" },
    { CcwResult_InvalidDeviceID,        "Device ID not valid or unknown" },
    { CcwResult_ReadError,              "Read data error" },
    { CcwResult_WriteError,             "Write data error" },
    { CcwResult_UnsupportedDevice,      "Device unknown or unsupported" },
    { CcwResult_CommunicationError,     "Communication error" },
    { CcwResult_BarcodeUnsupportedError, "Barcode type unknown or unsupported" },
    { CcwResult_BarcodeWidthError,      "Barcode width wrong or bigger than print width" },
    { CcwResult_DeviceAlreadyOpenError, "Device already open" },
    { CcwResult_PrinterNotExistError,   "Printer not found" },
    { CcwResult_UnknowPrinterError,     "Unknown Printer" },
    { CcwResult_OpenFileError,          "File not found or open error" },
    { CcwResult_CommunicationError,     "The communication with the device is busy" },
    { CcwResult_GraphicsLibraryNotFound,"Graphics library not found or not loaded correctly" },
    { CcwResult_BarcodeDataLongError,   "Barcode data is too long or too short for selected symbology" },
    { CcwResult_BarcodeInvalidDataError,"Barcode data includes characters which are not permitted by selected symbology" },
    
};


// @endcond


static const char* CcwResultToText(CcwResult result)
{
    DWORD i;

    for (i = 0; i < ERROR_CCW_LISTSIZE; i++){
        if (ERROR_CCW_LIST[i].ccwError == result)
            return ERROR_CCW_LIST[i].strDescription;
    }

    return "Unknown Error";
}


#endif